﻿/*
    This file is part of nDoctor Light

    NDoctor is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    NDoctor is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with NDoctor.  If not, see <http://www.gnu.org/licenses/>.
*/
namespace Probel.Ldoc.Services.Services
{
    using System;

    /// <summary>
    /// The Error Service is in charge of displaying the error and log it if needed
    /// </summary>
    public interface IErrorService
    {
        #region Methods

        /// <summary>
        /// Handles an error. An error An error normally asks to restart the application
        /// </summary>
        /// <param name="ex">The ex.</param>
        void HandleError(Exception ex);

        /// <summary>
        /// Handles the warning. A warning is a wrong bahaviour from the user. Just notify the user and continue
        /// to run the application.
        /// </summary>
        /// <param name="msg">The message to be displayed.</param>
        void HandleWarning(string msg);

        /// <summary>
        /// Uses the internal logger to log the debug information.
        /// </summary>
        /// <param name="msg">The message to log.</param>
        void LogDebug(object msg);

        /// <summary>
        /// Uses the internal logger to log the information.
        /// </summary>
        /// <param name="msg">The message to log.</param>
        void LogInfo(object msg);

        #endregion Methods
    }
}